<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - odr.Shape</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/Function.html">Function</a></li>
	
	<li><a href="../symbols/odr.html">odr</a></li>
	
	<li><a href="../symbols/odr.Association.html">odr.Association</a></li>
	
	<li><a href="../symbols/odr.Association.listener.html">odr.Association.listener</a></li>
	
	<li><a href="../symbols/odr.Drawable.html">odr.Drawable</a></li>
	
	<li><a href="../symbols/odr.Drawable.listener.html">odr.Drawable.listener</a></li>
	
	<li><a href="../symbols/odr.Endpoint.html">odr.Endpoint</a></li>
	
	<li><a href="../symbols/odr.Endpoint.listener.html">odr.Endpoint.listener</a></li>
	
	<li><a href="../symbols/odr.Handle.html">odr.Handle</a></li>
	
	<li><a href="../symbols/odr.Handle.listener.html">odr.Handle.listener</a></li>
	
	<li><a href="../symbols/odr.Label.html">odr.Label</a></li>
	
	<li><a href="../symbols/odr.Label.listener.html">odr.Label.listener</a></li>
	
	<li><a href="../symbols/odr.Line.html">odr.Line</a></li>
	
	<li><a href="../symbols/odr.Line.listener.html">odr.Line.listener</a></li>
	
	<li><a href="../symbols/odr.Node.html">odr.Node</a></li>
	
	<li><a href="../symbols/odr.Node.listener.html">odr.Node.listener</a></li>
	
	<li><a href="../symbols/odr.popup.html">odr.popup</a></li>
	
	<li><a href="../symbols/odr.Registry.html">odr.Registry</a></li>
	
	<li><a href="../symbols/odr.settings.html">odr.settings</a></li>
	
	<li><a href="../symbols/odr.Shape.html">odr.Shape</a></li>
	
	<li><a href="../symbols/odr.Shape.listener.html">odr.Shape.listener</a></li>
	
	<li><a href="../symbols/String.html">String</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class odr.Shape
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				<br />Extends
					<a href="../symbols/odr.Drawable.html">odr.Drawable</a>.<br />
				
			
				Base class for all drawable items that cover an area, can therefore be clicked and need to be taken into account
when the canvas is resized.
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/diagram-entities.js.html">diagram-entities.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class odr.Shape.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/odr.Shape.html#constructor">odr.Shape</a></b>()
							</div>
							<div class="description"></div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			
				
				
				
				
				<dl class="inheritsList">
				
				</dl>
				
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class odr.Shape.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/odr.Shape.html#bottomRight">bottomRight</a></b>()
								</div>
								<div class="description">Retrieve the bottom right coordinate of this element.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/odr.Shape.html#center">center</a></b>()
								</div>
								<div class="description">Retrieve the center coordinate of this element.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/odr.Shape.html#height">height</a></b>(height)
								</div>
								<div class="description">You can also retrieve the current value by calling this method without parameters.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/odr.Shape.html#isInside">isInside</a></b>(x, y)
								</div>
								<div class="description">Check whether the given coordinates lie in the shape</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/odr.Shape.html#marked">marked</a></b>(marked)
								</div>
								<div class="description">Set whether or not this element is marked.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/odr.Shape.html#move">move</a></b>(x, y)
								</div>
								<div class="description">Move the shape</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/odr.Shape.html#position">position</a></b>(x, y)
								</div>
								<div class="description">Update the whole position of a shape or retrieve the position.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/odr.Shape.html#size">size</a></b>(width, height)
								</div>
								<div class="description">Update the whole size of a shape or retrieve the size.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/odr.Shape.html#topLeft">topLeft</a></b>()
								</div>
								<div class="description">Retrieve the top left coordinate of this element.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/odr.Shape.html#width">width</a></b>(width)
								</div>
								<div class="description">You can also retrieve the current value by calling this method without parameters.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/odr.Shape.html#x">x</a></b>(x)
								</div>
								<div class="description">You can also retrieve the current value by calling this method without parameters.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/odr.Shape.html#y">y</a></b>(y)
								</div>
								<div class="description">You can also retrieve the current value by calling this method without parameters.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
				<dl class="inheritsList">
				<dt>Methods borrowed from class <a href="../symbols/odr.Drawable.html">odr.Drawable</a>: </dt><dd><a href="../symbols/odr.Drawable.html#addClass">addClass</a>, <a href="../symbols/odr.Drawable.html#bind">bind</a>, <a href="../symbols/odr.Drawable.html#classString">classString</a>, <a href="../symbols/odr.Drawable.html#fire">fire</a>, <a href="../symbols/odr.Drawable.html#hasClass">hasClass</a>, <a href="../symbols/odr.Drawable.html#id">id</a>, <a href="../symbols/odr.Drawable.html#parent">parent</a>, <a href="../symbols/odr.Drawable.html#removeClass">removeClass</a>, <a href="../symbols/odr.Drawable.html#unbind">unbind</a>, <a href="../symbols/odr.Drawable.html#visible">visible</a></dd>
				</dl>
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>odr.Shape</b>()
				</div>
				
				<div class="description">
					
					
				</div>
				
				
				
				
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="bottomRight"> </a>
					<div class="fixedFont">
					
					<span class="light">{Object}</span>
					<b>bottomRight</b>()
					
					</div>
					<div class="description">
						Retrieve the bottom right coordinate of this element.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Object}</span> An object with x and y properties.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="center"> </a>
					<div class="fixedFont">
					
					<span class="light">{Object}</span>
					<b>center</b>()
					
					</div>
					<div class="description">
						Retrieve the center coordinate of this element.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Object}</span> An object with x and y properties.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="height"> </a>
					<div class="fixedFont">
					
					<span class="light">{Number|odr.DrawableItem}</span>
					<b>height</b>(height)
					
					</div>
					<div class="description">
						You can also retrieve the current value by calling this method without parameters.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>height</b>
									<i>Optional</i>
								</dt>
								<dd>The new height</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Number|odr.DrawableItem}</span> The height which was set. If you call this method with a parameter then the
method will return the object on which you called the method.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="isInside"> </a>
					<div class="fixedFont">
					
					<span class="light">{Boolean}</span>
					<b>isInside</b>(x, y)
					
					</div>
					<div class="description">
						Check whether the given coordinates lie in the shape
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>x</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>y</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Boolean}</span> True when the coordinates lie in the shape, false otherwise</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="marked"> </a>
					<div class="fixedFont">
					
					<span class="light">{Boolean|<a href="../symbols/odr.Drawable.html">odr.Drawable</a>}</span>
					<b>marked</b>(marked)
					
					</div>
					<div class="description">
						Set whether or not this element is marked. The initial value is false.

You can also retrieve the current value by calling this method without parameters.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>marked</b>
									<i>Optional</i>
								</dt>
								<dd>The new marked value</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Boolean|<a href="../symbols/odr.Drawable.html">odr.Drawable</a>}</span> The marked value which was set. If you call this
method with a parameter then the method will return the object on which you called the method.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="move"> </a>
					<div class="fixedFont">
					
					<span class="light">{<a href="../symbols/odr.Shape.html">odr.Shape</a>}</span>
					<b>move</b>(x, y)
					
					</div>
					<div class="description">
						Move the shape
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>x</b>
									<i>Optional</i>
								</dt>
								<dd>The number of pixels which you want to move the shape on the x axis</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>y</b>
									<i>Optional</i>
								</dt>
								<dd>The number of pixels which you want to move the shape on the y axis</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/odr.Shape.html">odr.Shape</a>}</span> Returns the object of which you called the method.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="position"> </a>
					<div class="fixedFont">
					
					<span class="light">{Object|<a href="../symbols/odr.Shape.html">odr.Shape</a>}</span>
					<b>position</b>(x, y)
					
					</div>
					<div class="description">
						Update the whole position of a shape or retrieve the position. This method is to be prefered over x().y()
as it will only inform the listeners one time about the position changed. Therefore it can improve the
performance.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>x</b>
									<i>Optional</i>
								</dt>
								<dd>The new x coordinate</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>y</b>
									<i>Optional</i>
								</dt>
								<dd>The new y coordinate</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Object|<a href="../symbols/odr.Shape.html">odr.Shape</a>}</span> Returns odr.Shape when you pass an x and y parameter. If you call this method
without a parameter it will return the position as an object with x and y properties.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="size"> </a>
					<div class="fixedFont">
					
					<span class="light">{Object|<a href="../symbols/odr.Shape.html">odr.Shape</a>}</span>
					<b>size</b>(width, height)
					
					</div>
					<div class="description">
						Update the whole size of a shape or retrieve the size. This method is to be prefered over width()height()
as it will only inform the listeners one time about the size changed. Therefore it can improve the
performance.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>width</b>
									<i>Optional</i>
								</dt>
								<dd>The new width coordinate</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>height</b>
									<i>Optional</i>
								</dt>
								<dd>The new height coordinate</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Object|<a href="../symbols/odr.Shape.html">odr.Shape</a>}</span> Returns odr.Shape when you pass a width and height parameter. If you call this method
without a parameter it will return the size as an object with width and height properties.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="topLeft"> </a>
					<div class="fixedFont">
					
					<span class="light">{Object}</span>
					<b>topLeft</b>()
					
					</div>
					<div class="description">
						Retrieve the top left coordinate of this element.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Object}</span> An object with x and y properties.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="width"> </a>
					<div class="fixedFont">
					
					<span class="light">{Number|<a href="../symbols/odr.Shape.html">odr.Shape</a>}</span>
					<b>width</b>(width)
					
					</div>
					<div class="description">
						You can also retrieve the current value by calling this method without parameters.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>width</b>
									<i>Optional</i>
								</dt>
								<dd>The new width</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Number|<a href="../symbols/odr.Shape.html">odr.Shape</a>}</span> The width which was set. If you call this method with a parameter then the
method will return the object on which you called the method.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="x"> </a>
					<div class="fixedFont">
					
					<span class="light">{Number|<a href="../symbols/odr.Shape.html">odr.Shape</a>}</span>
					<b>x</b>(x)
					
					</div>
					<div class="description">
						You can also retrieve the current value by calling this method without parameters.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>x</b>
									<i>Optional</i>
								</dt>
								<dd>The new x coordinate</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Number|<a href="../symbols/odr.Shape.html">odr.Shape</a>}</span> The x coordinate which was set. If you call this method with a parameter then
the method will return the object on which you called the method.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="y"> </a>
					<div class="fixedFont">
					
					<span class="light">{Number|<a href="../symbols/odr.Shape.html">odr.Shape</a>}</span>
					<b>y</b>(y)
					
					</div>
					<div class="description">
						You can also retrieve the current value by calling this method without parameters.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>y</b>
									<i>Optional</i>
								</dt>
								<dd>The new y coordinate</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Number|<a href="../symbols/odr.Shape.html">odr.Shape</a>}</span> The y coordinate which was set. If you call this method with a parameter then
the method will return the object on which you called the method.</dd>
							
							</dl>
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Sun Dec 19 2010 14:46:06 GMT+0100 (CET)
		</div>
	</body>
</html>
